Added Weaver configuration for all telemetry, and a generated mkdocs site#2794
Added Weaver configuration for all telemetry, and a generated mkdocs site#2794julianocosta89 merged 26 commits intoopen-telemetry:mainfrom
Conversation
|
@martinjt can we configure live-check to ensure the telemetry schema is always up to date? I just don't want that to be another burden for maintainers. Also, the k8s manifests shouldn't be part of this PR. That is generated via helm update whenever we have a new release |
|
We can, i just didnt want to make it part of this PR since its already got a lot of moving parts. I can remove the k8s bits. |
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
@martinjt I had a chat with @puckpuck in the last SIG meeting and we were discussing this PR. Shouldn't we keep this PR just with the Something like how the semconv docs is currently done. |
|
My view is that we need to show people how to use Weaver for the things it's built for (Markdown documentation, and telemetry validation). The easiest of those to see is generating markdown. We show them how that's done in this repo, not be having another repo generate them and display them. If this repo had to have something else host the docs, that wouldn't be something that people could clone, run and iterate on. We need to show people how they can use weaver, give them a place to test it, just like we do with all the languages and their instrumentations. It's totally valid that the otel docs could ALSO use the schema to generate some more docs that are static and updated on a specific schedule. The repo, the helm chart and the images, should be able to run to allow the user to see all of them together, it shouldn't be that I run the demo, then consult the otel website for the docs (which could be for a different version). As an application developer, I would likely have a way of viewing the changes of the documentation, I'd maybe have something in my pipeline generate github pages. Either way, it's local to the repo and something that a developer can generate |
|
What if we keep the doc service as a different docker compose file? This would allow users to test weaver, but the docs services wouldn't always start with the Demo. |
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
|
|
@julianocosta89 @ps48 I've pushed an update to this PR that:
Also addressed the review comments:
Everything builds and serves correctly with the static nginx setup. |
|
@martinjt can you check the easyCLA issue? |
|
That should be done now @julianocosta89 |
|
@martinjt I ran I've added stability to the metrics (97abcc7 and bumped semconv to Now I'm only getting: But I guess this is expected. |
d13e944 to
62d37f6
Compare
- Bump otel/weaver Docker image from v0.21.2 to v0.22.1 - Rename registry_manifest.yaml to manifest.yaml (v0.22 deprecation) - Migrate attribute files to v2 schema (file_format: definition/2) - Migrate service files to v2 attribute_groups with visibility - Update jq filters in weaver.yaml for new resolved registry ID format - Add Apache license headers to Jinja2 template files - Fix readme.md.j2 to reflect actual schema file structure - Add TELEMETRY_DOCS_HOST/PORT env vars to docker-compose.minimal.yml - Update mkdocs site_url to localhost:8080/telemetry/ Note: Claude was used to assist with this change. The author has verified all work.
julianocosta89
left a comment
There was a problem hiding this comment.
I'd get this one merged and we can iterate from here
Changes
This adds a new service called
telemetry-docswhich serves a documentation site for the custom telemetry documented by the demo across all the services.It also includes a weaver registry for the all those attributes.
This does not include a live-check interface, that will come later, nor does this include codegen for these attributes or metrics.
Merge Requirements
For new features contributions, please make sure you have completed the following
essential items:
CHANGELOG.mdupdated to document new feature additionsMaintainers will not merge until the above have been completed. If you're unsure
which docs need to be changed ping the
@open-telemetry/demo-approvers.